Appendix A: Tokens

The format of tokens has changed for Laserfiche 8. All tokens, including Laserfiche 7 tokens, should now be in the format: %(token). The token format for previous versions of Laserfiche, $token$, will continue to be supported for legacy and migrated processes, but we strongly encourage the use of the new format.

A token is a placeholder for a value to be inserted. Laserfiche (including the scanning component) can take advantage of tokens to name new documents. Web Scanning can also use tokens to determine a folder location or to populate fields. The name, symbol, and description for each token are given below.

Note: The symbol inserted when selecting a token is a reference. Laserfiche and Web Scanning will automatically translate these tokens into the data they represent.

Name Symbol Applies To Description
Session Count %(Count) Web Access Client, Web Scanning,

A token that will be replaced by a sequential number every time an entry is created or imported into Laserfiche. By default, this token starts at 1. It can be configured by clicking Autoname under New Documents in the Settings dialog box in Web Access.

If you scan documents using standard mode, you can configure this option from the Settings tab of the Default Properties task pane.

Date %(Date) Web Access Client, Web Scanning, The system date from the current workstation.
Date/Time %(DateTime) Web Access Client, Web Scanning The system date and time from the current workstation.
Entry ID %(ID) Web Access Client, Web Scanning The identification number assigned to the Laserfiche document where data will be stored. This number will be generated when the Laserfiche document is created. Unlike most tokens, this token is replaced when the document is stored in Laserfiche.
Field Data %(Field) Web Scanning The value assigned to a field in the current document. The specified field must belong to the template that will be assigned to scanned documents. Unlike most tokens, this one is replaced when the document is stored in Laserfiche. Until then, the token will appear where it was inserted.
Field Data Inheritance %(Parent)

%(Parent: Field)
Web Access Client, Web Scanning

A document or folder inherits the value assigned to the field with the same name in the parent folder. If this token is used when a document or folder is being created, field data will be inherited from the folder in which the document or folder will be created. Once a document or folder inherits a field value, the parent token will be replaced with the value assigned to a field in the parent folder.

Note: A token will only be replaced once. If the parent's field data is updated, it does not update the children's field data. The parent token is not meant as a means of synchronizing field data between a folder and its children.

Example: If you insert the %(Parent) token in the "Name" field, it will be replaced by the value assigned to the "Name" field in the parent folder. If the parent folder has not been associated with a "Name" field, the token will not be replaced. If the parent folder has been associated with a "Name" field, and the value of that field changes, the token value will not be updated.

To inherit the value assigned to a field with a different name, use the %(Parent:Field) token. The term Field should be replaced with the name of the desired field associated with the parent folder. If the parent folder has not been associated with a field with the specified name, the token will not be replaced.

Repository Count %(GCount) Web Access Client, Web Scanning

A sequential number added every time an entry is created or imported into a Laserfiche Server. By default, this token starts at 1.

Example: User A and User B each create a document and use %(GCount). The server count is 3 because the server starts with 1 and each user has created a document.

GUID %(GUID) Web Access Client, Web Scanning The Globally Unique Identifier for an entry. This is a unique ID given to an entry to set it apart from the ID generated by Laserfiche and given to that same entry.
Hijri Date %(Hijri Date) Web Scanning The current Hijri date. This token is only available on non-date fields.
Hijri Date/Time %(Hijri DateTime) Web Scanning The current Hijri date and time. This token is only available on non-date/time fields.
Name %(Name) Web Access Client, Web Scanning The file name for the scanned image. This token is available for use with Laserfiche Universal Capture. It can also be used in the Client to populate fields for documents.
Path %(Path) Web Scanning The path to the file for the scanned image. This token is available for use with Laserfiche Universal Capture.
Page Count %(PageCount) Web Access Client, Web Scanning The number of pages in a document.
Parent ID %(Parent ID) Web Access Client, Web Scanning The ID of the entry's parent folder.
Parent Name %(Parent Name) Web Access Client, Web Scanning The name of the entry's parent folder.
Parent GUID %(ParentGUID) Web Access Client, Web Scanning The Globally Unique Identifier for the entry's parent folder. This is a unique ID given to a folder to set it apart from the ID generated by Laserfiche and given to that same folder.
System ID %(SID) Web Access Client, Web Scanning The security identifier from the current workstation. If multiple users create entries, Windows knows it's the same account.
Time %(Time) Web Access Client, Web Scanning The system time on the current workstation.
User Name %(UserName) Web Access Client, Web Scanning The name of the user sending documents to a repository. Unlike most tokens, this is replaced when the document is stored in Laserfiche. Until then, it will appear where it was inserted.
User SID %(UserSID) Web Access Client The Windows user's security identifier.

For further help or feedback, please see the Laserfiche Support Site. © 2009 Laserfiche. All Rights Reserved.